home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / AVOGADRO / CHEMISTRY / RASMOL / !RasMol / !Help < prev    next >
Text File  |  1996-08-20  |  25KB  |  475 lines

  1. RasMol 2.6beta2 / 1.20 (20-Aug-96)
  2.  
  3. Purpose:      Molecular Graphics Visualiser
  4. Author:       Roger Sayle (ras32425@ggr.co.uk)
  5. RISC OS port: Martin Würthner (wuerthne@trick.informatik.uni-stuttgart.de)
  6. Runs under:   RISC OS 3.1 or higher, supports RISC OS 3.5+ true colour modes
  7.               Version 1.10 has been tested successfully with StrongARM and
  8.               RISC OS 3.7, so I assume this version will work, too.
  9.               Requires at least 2MB RAM (see below "Saving memory"), at
  10.               least 4MB recommended.
  11. Status:       FREEWARE, see "Copyright" below
  12.  
  13. Version 1.20 of the RISC OS port of RasMol is based on the RasMol 2.6beta2
  14. sources. Note that the RasMol help file still describes version 2.5 of RasMol.
  15. Updated manuals in html format are available from the WWW home page (see
  16. below, "Links to molecule databanks and WWW pages about RasMol").
  17.  
  18. For information about the new features of 2.6beta 2 (most notably the full
  19. support for stereo pictures), read the release notes in the 'Docs' directory.
  20.  
  21. Contents:
  22.   * Introduction
  23.   * Starting RasMol
  24.   * First Steps
  25.   * Loading files
  26.   * Window size
  27.   * The tool bar: Selection, Rotation, Translation, Zooming, Z-slabbing
  28.   * Display quality and dithering
  29.   * Saving and exporting
  30.   * Configuration
  31.   * Saving memory
  32.   * Script files
  33.   * PC script directories
  34.   * Display types
  35.   * The View sub-menu and the "Dot surface" option
  36.   * Colours
  37.   * The RasMol Command Line
  38.   * Additional file types
  39.   * Links to molecule databanks and WWW pages about RasMol
  40.   * History
  41.   * How to contact the authors
  42.   * Copyright
  43.   
  44.   RasMol2 is a molecular graphics program intended for the visualisation of
  45. proteins, nucleic acids and small molecules. The program is aimed at display,
  46. teaching and generation of publication quality images. RasMol runs on
  47. Microsoft Windows, Apple Macintosh, Acorn RISC OS, UNIX and VMS systems. The
  48. UNIX and VMS systems require an 8, 24 or 32 bit colour X Windows display
  49. (X11R4 or later). The program reads in a molecule co-ordinate file and
  50. interactively displays the molecule on the screen in a variety of colour
  51. schemes and molecule representations. Currently available representations
  52. include depth-cued wireframes, 'Dreiding' sticks, spacefilling (CPK) spheres,
  53. ball and stick, solid and strand biomolecular ribbons, atom labels and dot
  54. surfaces.
  55.  
  56.   The RasMol help facility can be accessed by typing "help <topic>" or "help
  57. <topic> <subtopic>" from the RasMol command line. A complete list of RasMol
  58. commands may be displayed by typing "help commands". A single question mark
  59. may also be used to abbreviate the keyword "help".
  60.  
  61.   Copyright (c) 1992-1995 by Roger Sayle (ras32425@ggr.co.uk)
  62.  
  63.  
  64.  Starting RasMol
  65.  ---------------
  66.   When started (by double-clicking on the application itself or on a file which
  67. RasMol understands), RasMol installs itself onto the icon bar and opens two
  68. windows. These are the Molecule window (black) and the RasMol Command Line
  69. window. The Molecule window displays the currently loaded molecule and allows
  70. you to rotate/translate/z-slab it using the mouse.
  71.  
  72.  First steps
  73.  -----------
  74.   To get an idea what the program is about, double-click on the file '1crn' (this
  75. is a small protein file). If you have not already loaded RasMol, it should start up
  76. now. The protein is displayed in wireframe mode in the Molecule window (behind the
  77. Molecule window you can also see the Command Line window). Select the rotation tool
  78. (the tool below the "pointer" tool), click SELECT somewhere in the Molecule window
  79. and drag horizontally or vertically. This rotates the molecule about the x/y-axes.
  80. Using ADJUST, you can rotate about the z-axis. Now click MENU and choose "Spacefill"
  81. from the "Display" sub-menu. For a nice specular highlighting effect choose
  82. "Specular" from the "Options" sub-menu (do not try "Shadows" as it is very slow).
  83. If you are in a 16 or 256 colour mode, try the tool at the bottom of the toolbar
  84. which dithers the image to the current palette. This improves the display quality
  85. significantly but it takes a few seconds.
  86.   To test other ways of displaying the molecule, try also "Ball&Stick" and "Back-
  87. bone" from the "Display" sub-menu. While being in "Backbone" mode, select the
  88. translation tool (the one below the rotation tool). Click ADJUST somewhere in the
  89. window and drag slowly (!) vertically to zoom in/out.
  90.  
  91. Note that the program is fully multitasking, even while calculating complex images
  92. like dot surfaces or shadows. While the program is calculating the pointer changes
  93. to an hourglass while it is inside the RasMol window.
  94.  
  95.  Loading files
  96.  -------------
  97.   A Molecule files may be loaded by double-clicking on it or by dragging it
  98. to the RasMol icon on the icon bar or to the Molecule window.
  99.   Dragging a file to the Command Line window causes its full path name to be
  100. inserted at the caret position. This makes loading files from the command line
  101. easier.
  102.  
  103.  Currently recognised filetypes (allocated by Acorn) are:
  104.  
  105.  Industry standard name              DOS ext.   RISC OS name  type
  106.  -----------------------------------------------------------------
  107.  Brookhaven Protein Data Bank files  PDB        PDB           12A
  108.  Alchemy files                       ALC        Alchemy       129
  109.  Molecular Design Ltd. MOL files     MOL        MOL           128
  110.  MOPAC files                         ???        MOPAC         127
  111.  RasMol script files                 SCR        RasMolSc      12B
  112.  
  113. Note that files have to be filetyped correctly in order to be loaded by
  114. RasMol. If you load a file and all you see is a black window then most
  115. probably the file does not contain any connectivity information. Try
  116. entering "connect" in the command line window.
  117.  
  118.  Window size
  119.  -----------
  120.   The size of the Molecule window determines the speed of the application and
  121. also how much memory is used. The default size of the display is 480 by 480
  122. pixels. By choosing "Scale" from the main menu you can change the scaling of
  123. the window. 100% corresponds to 480 pixel. The width of the window is a
  124. percentage of its height, so a window at a scaling of 50% and a width of 150%
  125. would be 240 pixels high and 360 pixels wide.
  126.   To set the default size, change the configuration of the program (see below
  127. "Configuration").
  128.   Note that the memory you save by decreasing the window size is not given
  129. back to the system, so to save memory, change the window size used at start-
  130. up by changing the configuration.
  131.  
  132.  The tool bar: Selection, Rotation, Translation, Zooming, Z-slabbing
  133.  -------------------------------------------------------------------
  134.   The tool bar contains five tools. From top to bottom these are:
  135. The selection tool, the rotation tool, the translation/zooming tool, the
  136. z-slabbing tool and the dithering tool. The latter is described in detail
  137. in the section "Display quality and dithering".
  138.   The first four determine which interactive mode the program is in, i.e.
  139. how mouse clicks/drags are interpreted:
  140.  
  141. Select mode: If you click on an atom, information about it is displayed in
  142.              the Command Line window. Note that even though this is called
  143.              "selection mode", it has nothing to do with selecting groups
  144.              of atoms or single atoms using the command "select" on the command
  145.              line (for more information on this powerful feature, type "help
  146.              select" on the command line).
  147.                Using the command line you can also modify the behaviour of
  148.              the select mode, e.g. you can make RasMol add labels for the
  149.              atoms you click on by typing "Set picking label". See the
  150.              2.6beta1 release notes for further options, e.g. for displaying
  151.              distances and angles by clicking on atoms.
  152. Rotation mode: Dragging horizontally using SELECT rotates the molecule about
  153.                the y-axis. Dragging vertically using SELECT rotates the molecule
  154.                about the x-axis. Dragging vertically or horizontally using ADJUST
  155.                rotates the molecule about the z-axis.
  156.                Note that rotation works differently from the way it works in
  157.                ArtWorks or Draw where you drag along an arc. In RasMol you
  158.                should simply drag either horizontally or vertically.
  159. Translation/zoom mode: Dragging using SELECT translates ("moves") the molecule
  160.                        accordingly in the xy-plane. Dragging using ADJUST zooms
  161.                        in/out (i.e. it translates the molecule along the z-axis).
  162. Z-slab mode: This only has a visible effect if the "z-slabbing" option is ticked
  163.              in the "Options" menu. Z-slabbing allows you to see "inside" the
  164.              molecule by slabbing it against a vertical plane. The slab plane can
  165.              be moved along the z-axis by dragging with either mouse key.
  166. Dither tool: See next passage
  167.  
  168.  Display quality and dithering
  169.  -----------------------------
  170.   RasMol produces bitmaps with 256 colour palettes, so they do not display very
  171. well in RISC OS 256 colour modes with the standard fixed palette. In particular
  172. space filling representations look very poor in 256 colour modes. 
  173.  
  174.   Therefore the RISC OS version of RasMol is able to produce dithered output
  175. using more or less the same algorithm ChangeFSI uses to dither images. This
  176. takes a few seconds, but the results are worth while the delay. Dithering works
  177. in both 256 and 16 colour modes. As dithering is quite time-consuming, it is only
  178. performed on request, that is if you click on the "Dither" tool (the bottom tool
  179. on the tool bar). Of course, as soon as the display changes (e.g. because you
  180. change a display option or you rotate the molecule), the picture is recalculated,
  181. so it has to be dithered again. Normally, you would first set all the options you
  182. want, e.g. "Spacefill" and "Specular" etc. and then only when everything is
  183. OK dither the image for final output.
  184.  
  185.   Note that if you subsequently save the image as a sprite, the dithered version
  186. is saved! This is a good option if the main purpose of the picture is to be
  187. viewed, in particular on machines without true colour modes. If however, you
  188. are planning to print the image, you are advised to save the undithered
  189. version (you can revert to the undithered version by choosing "Recalculate"
  190. from the main menu). Even though this looks worse on screen it prints much better
  191. in particular if it is scaled before printing!
  192.  
  193.   To compare RasMol's internal dithering with ChangeFSI, try exporting the
  194. undithered sprite (which contains a full 256 colour palette) and feed it through
  195. ChangeFSI.
  196.  
  197.  There are several other ways of improving output quality:
  198.  1) for RiscPC owners with VRAM:
  199.     * Change to a 32768 colour mode
  200.  2) for owners of a CC ColourCard:
  201.     * Change the 256 colour palette e.g. using the "PalMaker" utility. This
  202.       gives the same display quality as a 16 millon colour mode!
  203.  3) * save the sprite and feed it through ChangeFSI as suggested above
  204.  
  205.  Saving and exporting
  206.  ---------
  207.   The current display can be saved as a sprite using the menu item "File.Save
  208. sprite" from the main menu. This saves the image as a 256 colour sprite with
  209. a full 256 colour palette (not suitable for RISC OS 2 unless you load the
  210. sprite into !Paint and remove the palette). If the currently displayed image
  211. is dithered, the dithered version is saved. Note that it is not possible to
  212. save a 16 colour sprite, even if the current image has been dithered to 16
  213. colours. Feed the undithered image through ChangeFSI to achieve this effect.
  214.  
  215.   "File.Export.GIF" allows you to save the current image (only if it is not
  216. dithered) as a 256 colour GIF file with a 256 colour palette.
  217.  
  218.   "File.Export.EPS (bitmap)" saves an EPS file containing the bitmap.
  219.  
  220.   "File.Export.Vector PS" is a very powerful option which is not fully
  221. implemented yet. However, for some representations it should work already.
  222. This output can be fed through a PostScript interpreter, e.g. RiScript to
  223. produce a Drawfile. However, do not expect too much, both vector PS export
  224. and RiScript are rather unstable still.
  225.  
  226.  Configuration
  227.  -------------
  228.   RasMol provides some basic configuration options that can be set by choosing
  229. "Choices" from the icon bar menu.
  230. The "Time slice" option determines how much CPU time the program takes.
  231. Decreasing the value means that the desktop is slowed down less, but it may
  232. take longer to calculate an image. Increasing the value means that more
  233. CPU time is taken. If you enter 0, then multitasking is disabled completely
  234. while images are calculated.
  235.  
  236.   The "Default scale" and "Default width" entries correspond to the menu entries
  237. of the same name. They can be used to set the values to be used at start-up
  238. time of the program. Note that a smaller window uses less memory.
  239.  
  240.   Note that if you disable the toolbox by deselecting the "Display toolbox"
  241. option, RasMol reverts to the standard interpretation of mouse operations as
  242. used by the X11 or MS Windows version:
  243.  
  244.  with Ctrl held down:  z-slab mode
  245.  with Shift held down: SELECT: rotate about z-axis
  246.                        ADJUST: zoom mode
  247.  else: SELECT: translate in the xy plane
  248.        ADJUST: rotate about x- and y-axes
  249.  
  250.  Saving memory
  251.  -------------
  252.   RasMol just about starts up on a 2MB machine. For the first time, you might
  253. have to do a clean boot and switch to a 16 colour mode before RasMol would
  254. start. To save memory permanently, reduce the window size (not using the main
  255. menu, but using the iconbar "Choices" item) and click on the Save button. Then
  256. reload the application. Most options do not need any extra memory and most
  257. molecules are rather small. You should however avoid the "Dot surface" option
  258. as this takes lots of extra memory.
  259.  
  260.  Script files
  261.  ------------
  262.   Script files may contain an arbitrary number of RasMol commands. For details
  263. refer to the RasMol manual. Script files must have the file type "RasMolSc"
  264. in order to be recognised by RasMol. Double-clicking on a script file or
  265. dragging it to one of the RasMol windows starts the script. Scripts do not
  266. multitask, but you can abort them by pressing and holding down the Escape key
  267. until the hourglass disappears.
  268.   A script file which reproduces the current setup can be saved using the
  269. "File.Save script" menu item. It does not include all options, e.g. the "Dot
  270. surface" option is ignored. However, it is a good point to start from if you
  271. want to be able to restore a certain set of options later.
  272.   Note that using scripts you can produce running demonstrations: Use the
  273. refresh command to force the screen to be updated while the script is running.
  274. The pause command can be used to ask the user to press a key to go on. When
  275. doing so it is advisable to use the echo command to print some text in the
  276. command window like "Press any key to go on".
  277.  
  278.  PC script directories
  279.  ---------------------
  280.   Some people have built script directories which contain molecule files and
  281. scripts. Usually, there is one main entry script to be started called
  282. something.TOP. On the PC platform you would change the current directory to
  283. the script directory and then run the script. This way, the script can
  284. reference the molecule files without any pathname but simply by specifying
  285. their name.
  286. In order to make porting of these directories easier, RasMol provides the
  287. following features:
  288. - automatic conversion of PC filenames to Acorn filenames, e.g. a command
  289.   "load DNA.PDB" is automatically converted to "load DNA/PDB".
  290. - if a file is not found, RasMol looks inside the directory specified by
  291.   the system variable RasMol$FileDir
  292. So all you have to do is to give the main script file (the one ending in
  293. /TOP) the correct type "RasMolSc" and add a !Run file to the directory which
  294. reads as follows:
  295.  
  296.  Set RasMol$FileDir <Obey$Dir>
  297.  Filer_Run */TOP
  298.  
  299. (or, if there are several files ending in /TOP, quote the name of the file
  300. you want to be run, e.g. Filer_Run DNA/TOP)
  301.  
  302. Double-clicking on the !Run file sets up the variable and starts the script.
  303. If you turn the script directory in an application by giving it a name starting
  304. with '!', you can even double-click on the directory. Script directories are
  305. available from the WWW home page (see below "Links to molecule databanks and WWW
  306. pages about RasMol").
  307.  
  308.  Display types
  309.  -------------
  310.   When loaded, a molecule is displayed in Wireframe mode. To change the
  311. display mode, bring up the main Menu by pressing the middle mouse button over
  312. the Molecule window. From the "Display" submenu you can choose your preferred
  313. display style from the following:
  314.  - Wireframe         - Ball&Stick
  315.  - Backbone          - Ribbons
  316.  - Sticks            - Strands
  317.  - Spacefill         - Cartoons
  318.  The default is Wireframe. This is also the fastest way of displaying the molecule.
  319. Use this style if you want to translate/rotate the molecule a lot, as these operations
  320. work in real time in Wireframe mode.
  321.  The sub-menu of "Wireframe" lets you to choose solid or dashed lines (the "dashed"
  322. item is a shortcut for the "wireframe dash" command).
  323.  The sub-menu of "Sticks" allows you to enter the thickness of the sticks. Pressing
  324. "Default" fills in the default value (which is 40, or 80 if the molecule has more than
  325. 256 atoms).
  326.  
  327.  For more details on these styles, type "help <display style>" on the RasMol
  328. command line.
  329.  
  330.  The View sub-menu and the "Dot surface" option
  331.  ----------------------------------------------
  332.   These are minor options like whether or not axes are to be displayed. The only
  333. really important item is "Dot surface" which displays a Van der Waal's dot surface
  334. around each atom. The density may be specified in the sub-menu, 100 is the default
  335. value, but you can enter values up to 1000. Note that the dot surface is actually
  336. calculated and stored in memory, so this option takes some computation time and
  337. also quite a bit of memory if the molecule is large. Using the "colour dots" command
  338. you can create some interesting effects, e.g. "colour dots potential" which colours
  339. the dots according to their electrostatic potential.
  340.  
  341.  Colours
  342.  -------
  343.   This submenu implements the RasMol "colour" command. For Wireframe, Sticks,
  344. Spacefill and Ball&Stick mode, you would normally use the CPK colouring which
  345. is chosen by default when a molecule is loaded. Choosing a menu item always
  346. sets the colour scheme for the whole of the molecule.
  347.   If you want to colour
  348. part of a molecule use the "select" and "colour" commands from the command
  349. line.
  350.   For details on the colour schemes listed on the menu, type "help <colour
  351. scheme>". Note that choosing "User" only makes sense if the currently loaded
  352. file is a PDB file which contains user-defined colour information.
  353.  
  354.  The RasMol Command Line
  355.  -----------------------
  356.   The Command Line window allows you to enter RasMol commands. These are described
  357. in the main RasMol manual. Typically, the menu entries only give a quicker way of
  358. accessing the most frequently needed command line features. Therefore most of the
  359. menu options are only described briefly in this RISC OS-specific file. For further
  360. information, use RasMol's command line help system. Entering "help" displays
  361. information about the help system.
  362.   It is worth noting that you need to use the command line to use the program
  363. to its full extent. For example, most menu options apply to the whole molecule,
  364. e.g. the display type or colour settings. Using the command line, however, it is
  365. possible to select parts of the molecule (e.g. all Hydrogen atoms or only specific
  366. amino acids) and apply display style or colouring commands to them. In fact, most
  367. RasMol commands only affect the current selection (type "help select" to find out
  368. how to select groups of atoms). Many commands take parameters which make them more
  369. versatile than their menu conterparts.
  370.   Other features include calculation and display of hydrogen bonds, SS-bonds,
  371. calculating connectivity information for molecule files without bonding etc.
  372.   Note that the release notes '26beta1' and '26beta2' in the 'Docs' directory 
  373. describe additional commands and options not included in the help file.
  374.   Some command line commands interact with the user interface, e.g. the "Set picking
  375. xxx" commands which define what happens if you click on an atom (see '26beta1').
  376. You can label atoms and find out about distances, angles and torsions etc.
  377.  
  378.  Additional file types
  379.  ---------------------
  380.   Files of the following types can only be loaded using the command line:
  381. Tripos' Sybyl Mol2 file format, the CHARMm file format and  MSC's XMol XYZ
  382. file format. To load these, type "load <format> <filename>" (where <format>
  383. is "mol2", "charmm" or "xyz" respectively) and press Return. Alternatively,
  384. type "load <format> " and drag the file to the Command Line window. Then
  385. press the Return key.
  386.  
  387.   Note that you can only have one file loaded at a time. If you try to load
  388. a file from the command line while there is a file in memory, you get an
  389. error message. If this happens, clear the database by entering "zap", then
  390. try again. If you load a file by dragging it to the program or by double-
  391. clicking on it, the database is cleared automatically before the file is
  392. loaded.
  393.  
  394.  Links to molecule databanks and WWW pages about RasMol
  395.  ------------------------------------------------------
  396. The RasMol WWW home page:    http://klaatu.oit.umass.edu:80/microbio/rasmol/
  397. This page is provided by Eric Martz. It contains frequently updated information
  398. about RasMol and lots of links to sites where you can get molecule files.
  399.  
  400. An enormous collection of proteins is available from the Brookhaven Protein
  401. Databank at www.pdb.bnl.gov.
  402.  
  403. Okanagan University molecule files: http://www.okanagan.bc.ca/chem/molecule/
  404.  
  405. And many more which you will find on the RasMol WWW home page.
  406.  
  407.  History
  408.  -------
  409.  Version 1.20 (19-08-96):
  410.  - based on RasMol 2.6beta2
  411.  - updated this !Help file
  412.  - included 26beta1 and 26beta2 release notes
  413.    (slighly modified for RISC OS release)
  414.  - pressing Return is possible in Scale view dialogue box
  415.  - fixed bug which caused the palette to be corrupted after
  416.    scaling (this affected saving as Sprite as well)
  417.  - sorry, no other changes to the RISC OS front-end yet...
  418.  
  419.  Version 1.10 (02-Apr-96):
  420.  - based on RasMol 2.6beta
  421.  
  422.  How to contact the authors
  423.  --------------------------
  424.   Please direct any comments about the RISC OS version to me:
  425.    Martin Wuerthner
  426.    Jahnstrasse 18
  427.    71116 Gaertringen
  428.    Germany
  429.    wuerthne@trick.informatik.uni-stuttgart.de
  430.  
  431.   Please direct any non-RISC OS-specific comments about the program to
  432. Roger Sayle, because he really wrote the whole thing and all the credits
  433. are due to him:
  434.    Roger Sayle
  435.    ras32425@ggr.co.uk
  436.  
  437.  Copyright
  438.  ---------
  439.   This program, the RISC OS port of RasMol 2.6, may be distributed freely
  440. provided that all its files are supplied unaltered and no profit is made
  441. on its distribution. The implementation of the RISC OS specific features is
  442. Copyright © 1996 by Martin Würthner (wuerthne@trick.informatik.uni-stuttgart.de).
  443. The main part of the program is Copyright © 1992-94 by Roger Sayle.
  444.  
  445. For further copyright information refer to the following passage quoted from
  446. the RasMol manual:
  447.  
  448. QUOTE BEGINS
  449.  
  450.   This document and the software, RasMol Version 2.6 which it describes,
  451. are Copyright © 1992,1993,1994 by Roger Sayle (rasmol@ggr.co.uk).
  452.  
  453.   The information supplied in this document is believed to be true but no 
  454. liability is assumed for its use or for the infringements of the rights of 
  455. the others resulting from its use. 
  456.  
  457.   Information in this document is subject to change without notice and does 
  458. not represent a commitment on the part of the supplier. This package is 
  459. sold/distributed subject to the condition that it shall not, by way of trade 
  460. or otherwise, be lent, re-sold, hired out or otherwise circulated without 
  461. the supplier's prior consent, in any form of packaging or cover other than 
  462. that in which it was produced. No part of this manual or accompanying 
  463. software may be reproduced, stored in a retrieval system on optical or 
  464. magnetic disk, tape or any other medium, or transmitted in any form or by 
  465. any means, electronic, mechanical, photocopying, recording or otherwise for 
  466. any purpose other than the purchaser's personal use. 
  467.  
  468.   This product is not to be used in the planning, construction, maintenance, 
  469. operation or use of any nuclear facility nor the flight, navigation or 
  470. communication of aircraft or ground support equipment. The author shall not 
  471. be liable, in whole or in part, for any claims or damages arising from such 
  472. use, including death, bancruptcy or outbreak of war. 
  473.  
  474. QUOTE ENDS
  475.